home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / prmpt.zip / PRMPT.DOC < prev    next >
Text File  |  1987-12-06  |  2KB  |  59 lines
  1. Docs for Prmpt.com - batch file query utility
  2. R. Trevithick, 12/06/87
  3.  
  4.  
  5. This little (104 byte) assembler module allows you to query the user
  6. from within a batch file.
  7.  
  8. The syntax is PRMPT "string to display",list of single keys allowed
  9.  
  10. Example:
  11.  
  12.         prmpt "Do you wish to proceed (Y/N) ? ",yn
  13.  
  14. This would cause the part within the quotes to be displayed, and would 
  15. then wait for the user to press either y or n (case does not matter).
  16.  
  17. If the user pressed y, errorlevel 1 would be returned, and n would cause 
  18. errorlevel 2.  Your batch file can, of course, test for these errorlevel 
  19. codes and proceed accordingly.
  20.  
  21. There is one option available.  If you use single quotes (') instead of 
  22. double ("), the user will not be able to exit by pressing ctrl-c or 
  23. ctrl-break.  The double quotes use service 8h and the single quotes use 
  24. service 7h.  Note that these services do not echo characters to the 
  25. screen.
  26.  
  27. The following batch file displays a typical way of using this:
  28.  
  29.  
  30.           prmpt 'Do you want to proceed (Yes/No/Abort) ? ',yna
  31.           if errorlevel 3 echo Abort
  32.           if errorlevel 3 goto END
  33.           if errorlevel 2 echo No
  34.           if errorlevel 2 goto END
  35.           if errorlevel 1 echo Yes
  36.           :END
  37.  
  38.  
  39. This will merely print out the word which corresponds to the user's 
  40. choice, demonstrating how to use the errorlevel condition testing within 
  41. a batch file.  The example above uses single quotes around the prompt 
  42. (message) part of the command, so control-break will not allow exit.
  43.  
  44.  
  45. Note:  Do not include a space after the comma unless you actually want 
  46. the space character to be included in the list of valid responses.  Also 
  47. note that virtually no error testing is done, in the interest of keeping 
  48. the .com file small.  If you just invoke it without any parameters, it
  49. will exit immediately without setting an errorlevel.  But if you invoke 
  50. it with only part of what it needs (e.g., a quoted message but no key 
  51. selection list) it will use whatever garbage it finds already in memory.
  52.  
  53.  
  54. ------Changes as of 12/03/87 revision----------
  55.  
  56. -Added code to detect and absorb dual scan code keys such as function 
  57.  keys.
  58.  
  59.